Inside Macintosh: QuickDraw GX Graphics /

Chapter 3 - Geometric Styles / Geometric Styles Reference

Functions / Getting and Setting Joins

GXGetShapeJoin

You can use the GXGetShapeJoin function to retrieve the join information from the style object of a shape.

gxJoinRecord *GXGetShapeJoin(gxShape source, gxJoinRecord *join);

source

A reference to the shape whose join information you want to retrieve.

join

A pointer to a gxJoinRecord structure. On return, this structure contains the join information for the source shape.

function result

A copy of the gxJoinRecord structure associated with the source
shape's style object.

DESCRIPTION

The GXGetShapeJoin function returns as its function result, and in the join parameter, a pointer to a gxJoinRecord structure containing the join information for the style object of the shape specified by the source parameter.

This function creates a new shape to encapsulate the join geometry, and places a reference to this shape in the join field of the returned gxJoinRecord structure. You should dispose of this shape when you no longer need it.

Since this function copies the join information from the source shape's style, you may make changes to the gxJoinRecord structure returned by this function without affecting the source shape's joins. If you want to change the join information for the source shape, you must use the GXSetShapeJoin function.

SPECIAL CONSIDERATIONS

Unless an error results, the GXGetShapeJoin function creates a shape; you are responsible for disposing of this shape when you no longer need it. See Inside Macintosh: QuickDraw GX Objects for information about disposing of QuickDraw GX objects.

ERRORS, WARNINGS, AND NOTICES

Errors
out_of_memory
shape_is_nil
parameter_is_nil

SEE ALSO

For a discussion of joins, see "Joins" on page 3-25.

For examples of adding joins to shapes, see "Adding Joins to a Shape" on page 3-61 and "Adding Standard Joins to a Shape" on page 3-64.

For a discussion of the gxJoinRecord structure and a description of what types of shapes you can use as join shapes, see "The Join Structure" on page 3-101.

To retrieve join information from a style object, use the GXGetStyleJoin function, which is described on page 3-129. To specify join information for a style object, use the GXSetStyleJoin function, which is described on page 3-130.

To specify join information for a style object associated with a particular shape, use the GXSetShapeJoin function, which is described in the next section.

Main | Page One | What's New | Apple Computer, Inc. | Find It | Contact Us | Help